SetPropertyValue method


	BlueCielo Meridian Enterprise 2012 Developer's Guide \| BlueCielo ECM Solutions

SetPropertyValue method

Changes the value of a given property for the CurrentObject property.

Syntax

Function SetPropertyValue(
          PropertySetName As String,
          PropertyDefName As String,
          Value,
          [IgnoreEditMode As Boolean = False]) As Boolean

Parameters
Name	Description
PropertySetName	The internal name of the property set that contains the property.
PropertyDefName	The internal name of the property whose value needs to be set.
Value	The new value for the property.
IgnoreEditMode	See Remarks.

Return Value

Returns True if the property value was set correctly.

Remarks

Memo type properties should not be set to Empty or type mismatch errors can occur. The changed value is not immediately stored to the server. Instead, the interface extension designer caches the value until the current operation (for example, edit property page) is completed.

PropertySetName

If the PropertySetName is empty, the custom property set defined by the extension is used.

IgnoreEditMode

Changing a property value is normally done by using the ApplyChanges method of a property page. In this case the extension (designer) is in edit mode. Set this argument to True when changing a property value by using the OnExecute method for a command.